Typing

Service

class Service(enum.Enum)

Attributes:

• taxi
• drive
• eats
• tanker
• cargo
• travel
• grocery

Role

class Role(enum.Enum)

Attributes:

• department_manager
• department_secretary
• client_manager

Geo

class Geo(enum.Enum)

Attributes:

• circle

PromocodeOrderService

class PromocodeOrderService(enum.Enum)

Attributes:

• taxi
• grocery
• eats

SortingOrder

class SortingOrder(enum.Enum)

Attributes:

• asc
• desc

TimeRestrictionType

class TimeRestrictionType(enum.Enum)

Attributes:

• weekly_date
• range_date

Day

class Day(enum.Enum)

Attributes:

• monday
• tuesday
• wednesday
• thursday
• friday
• saturday
• sunday

MeasureKind

class MeasureKind(enum.Enum)

Attributes:

• money
• volume

MeasurePeriod

class MeasurePeriod(enum.Enum)

Attributes:

• day
• week
• month

ApproveRole

class ApproveRole(enum.Enum)

Attributes:

• client
• manager

GeoHotelPolicyType

class GeoHotelPolicyType(enum.Enum)

Attributes:

• included
• excluded

CountriesRestriction

class CountriesRestriction(enum.Enum)

Attributes:

• rus
• cis

TravelClass

class TravelClass(enum.Enum)

Attributes:

• economy
• business
• premium
• first

SortingField

class SortingField(enum.Enum)

Attributes:

• due_date
• finished_date

SortingDirection

class SortingDirection(enum.Enum)

Attributes:

• asc
• desc

TaxiOrderCancelRulesState

class TaxiOrderCancelRulesState(enum.Enum)

Attributes:

• free
• paid
• minimal

OrdersCostTravelLimitPeriod

class OrdersCostTravelLimitPeriod(enum.Enum)

Attributes:

• month
• quarter
• year

AccumulationPeriod

class AccumulationPeriod(enum.Enum)

Attributes:

• week
• month
• quarter
• last_month

EatsOrdersListRequest

class EatsOrdersListRequest

Attributes:

• user_ids: List[str] — array of IDs of employees who placed orders.

Methods:

• serialize — converts a class to JSON.

EatDiscountResponse

class EatDiscountResponse

Attributes:

• sum: str — amount excluding VAT.
• vat: str — VAT.
• with_vat: str — amount with VAT.
• sales_tax: Optional[str] — sales tax.
• total: Optional[str] — total.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

EatTransactionsTotalResponse

class EatTransactionsTotalResponse

Attributes:

• sum: Optional[str] — amount.
• with_vat: Optional[str] — amount with VAT.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

EatOrderModifierResponse

class EatOrderModifierResponse

Attributes:

• name: str — the name of the dish add-on.
• cost: str — price excluding VAT. Returned only for completed orders.
• vat: str — VAT. Returned only for completed orders.
• cost_with_vat: str — price with VAT. Returned only for completed orders.
• count: Optional[int] — number.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

EatOrderCalculationResponse

class EatOrderCalculationResponse

Attributes:

• name: str — dish name.
• cost: str — price excluding VAT. Returned only for completed orders.
• vat: str — VAT. Returned only for completed orders.
• cost_with_vat: str — price with VAT. Returned only for completed orders.
• modifiers: Optional[List[EatOrderModifierResponse]] — dish modifiers.
• count: Optional[int] — number.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

CostCenter

class CostCenter

Attributes:

• id: str — cost center ID.
• title: str — the name of the cost center.
• value: str — value.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

EatOrderItemResponse

class EatOrderItemResponse

Attributes:

• id: str — order ID.
• user_id: str — user ID.
• status: str — order status.
• created_at: str — order creation date and time. Value format: YYYY-MM-DDThh:mm:ss±hh:mm
• department_id: Optional[str] — department ID.
• closed_at: Optional[str] — date and time the order was completed. Value format: YYYY-MM-DDThh:mm:ss±hh:mm
• restaurant_name: Optional[str] — restaurant name.
• destination_address: Optional[str] — delivery address.
• order_calculation: Optional[List[EatOrderCalculationResponse]] — order composition.
• final_cost: Optional[str] — price excluding VAT. Returned only for completed orders.
• vat: Optional[str] — VAT. Returned only for completed orders.
• final_cost_with_vat: Optional[str] — price including VAT. Returned only for completed orders.
• corp_discount: Optional[EatDiscountResponse] — corporate discount.
• corp_discount_reverted: Optional[bool] — cancellation of corporate discount.
• currency: Optional[str] — currency.
• eats_cost_centers: Optional[List[CostCenter]] — cost centers for the Eats service.
• transactions_total: Optional[EatTransactionsTotalResponse] — total transactions.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

EatOrderListResponse

class EatOrderListResponse

Attributes:

• orders: List — list of orders with descriptions.
• limit: Optional[int] — maximum number of returned records.
• cursor: Optional[str] — current request marker.
• sorting_order: Optional[str] — the sorting direction of the order array (by order creation date).

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

SupportedRequirementSelectOptionResponse

class SupportedRequirementSelectOptionResponse

Attributes:

• name: str — option name (in Latin letters).
• label: str — the name of the requirement the option is related to.
• title: str — option name.
• weight: Optional[float] — weight.
• max_count: Optional[int] — maximum number.
• value: Optional[float] — volume.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

SupportedRequirementSelectResponse

class SupportedRequirementSelectResponse

Attributes:

• type_select: str — value type.
• option: List[SupportedRequirementSelectOptionResponse] — array of options.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

SupportedRequirementItemResponse

class SupportedRequirementItemResponse

Attributes:

• name: str — requirement name (in Latin letters).
• label: str — requirement name.
• glued: Optional[bool] — glued requirement.
• type_requirement: Optional[str] — requirement type, possible values: select, boolean.
• multiselect: Optional[bool] — whether multiple selection is available.
• max_weight: Optional[float] — maximum weight.
• select: Optional[SupportedRequirementSelectResponse] — requirement description, specified only for requirements of the select type.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

TariffClassItemResponse

class TariffClassItemResponse

Attributes:

• name: str — service class name (in Latin letters).
• name_translate: str — service class name.
• supported_requirements: List[SupportedRequirementItemResponse] — array of requirements.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

ZoneInfoResponse

class ZoneInfoResponse

Attributes:

• tariff_classes: List[TariffClassItemResponse — array of service classes.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

GeoCircle

class GeoCircle

Attributes:

• center: List[float] — center coordinates.
• radius: Union[int, float] — distance from the center (in meters).

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

BaseGeoRestrictions

class BaseGeoRestrictions

Attributes:

• name: str — name.
• geo: GeoCircle — description of the geo restriction.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

GeoRestrictions

class GeoRestrictions

Attributes:

• geo_type: Geo — type of geo restriction, currently only circle is available.

Methods:

• serialize — converts a class to JSON.

GeoRestrictionsItemResponse

class GeoRestrictionsItemResponse

Attributes:

• id: str — identifier.
• geo_type: str — type of geo restriction.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

GeoRestrictionsListResponse

class GeoRestrictionsListResponse

Attributes:

• items: List[GeoRestrictionsItemResponse] — list of geo restrictions.
• limit: int — number of records to display.
• amount: int — total number of records.
• offset: int — number of records to skip.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

GeoRestrictionsResponse

class GeoRestrictionsResponse

Attributes:

• id: str — ride area ID.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

CodeUsageResponse

class CodeUsageResponse

Attributes:

• used_at: str — where the code is used.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

CodeItemResponse

class CodeItemResponse

Attributes:

• id: str — code ID.
• code: str — code.
• status: str — code status.
• usages: List[CodeUsageResponse] — usages.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

CodeListResponse

class CodeListResponse

Attributes:

• codes: List[CodeItemResponse] — list of codes.
• next_cursor: Optional[str] — a marker for the next request.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

BankName

class BankName

Attributes:

• ru: str — bank name in Russian.
• en: str — bank name in English.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

RawPromocodeGeoRestrictionsPointResponse

class RawPromocodeGeoRestrictionsPointResponse

Attributes:

• corp_geo_id: str — promo code geo restriction ID.
• name: str — name of the geo restriction.
• geo: GeoCircle — area coordinates.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

RawPromocodeGeoRestrictionsResponse

class RawPromocodeGeoRestrictionsResponse

Attributes:

• source: Optional[RawPromocodeGeoRestrictionsPointResponse] — starting point geo restrictions.
• destination: Optional[RawPromocodeGeoRestrictionsPointResponse] — destination geo restrictions.
• max_intermediate_points: Optional[int] — maximum number of intermediate points.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

PromocodeGeoRestrictionsPoint

class PromocodeGeoRestrictionsPoint

Attributes:

• geo_restriction_id: str — geo restriction ID.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

PromocodeGeoRestrictions

class PromocodeGeoRestrictions

Attributes:

• source: Optional[PromocodeGeoRestrictionsPoint] — starting point geo restrictions.
• destination: Optional[PromocodeGeoRestrictionsPoint] — destination geo restrictions.
• max_intermediate_points: Optional[int] — maximum number of intermediate points.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

PromocodeOrderPriceResponse

class PromocodeOrderPriceResponse

Attributes:

• cost: str — price excluding VAT.
• cost_with_vat: str — price with VAT.
• vat: str — VAT.
• currency: Optional[str] — currency.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

PromocodeCreateResponse

class PromocodeCreateResponse

Attributes:

• order_id: str — order ID.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

BasePromocodeOrder

class BasePromocodeOrder

Attributes:

• value: int — promo code value.
• count: int — number.
• active_until: str — expiration date.
• bin_ranges: Optional[List[list]] — range of values.
• bank_name: Optional[BankName] — bank name.
• classes: Optional[List[str]] — classes.

Methods:

• serialize — converts a class to JSON.

Promocode

class Promocode(BasePromocodeOrder)

Attributes:

• name: str — promo code name.
• active_from: Optional[str] — the date the promo code starts working.
• max_usages_count: Optional[int] — maximum number of uses.
• service: Optional[PromocodeOrderService] — the service where promo codes can be used.
• geo_restrictions: Optional[List[PromocodeGeoRestrictions]] — geolocation restrictions.

Methods:

• serialize — converts a class to JSON.

PromocodeOrderResponse

class PromocodeOrderResponse(BasePromocodeOrder)

Attributes:

• order_id: str — order ID.
• status: str — status.
• pricing: PromocodeOrderPriceResponse — order price.
• service: str — the service where promo codes can be used.
• geo_restrictions: Optional[List[RawPromocodeGeoRestrictionsResponse]] — array of geo restrictions.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

PromocodeOrderListResponse

class PromocodeOrderListResponse

Attributes:

• orders: List[PromocodeOrderResponse] — array of orders.
• next_cursor: Optional[str] — cursor.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

PromocodeOrderCancelResponse

class PromocodeOrderCancelResponse

Attributes:

• status: str — order cancellation status.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

TankerOrderItemResponse

class TankerOrderItemResponse

Attributes:

• id: str — order ID.
• user_id: str — employee ID.
• client_id: str — client ID.
• created_at: str — order creation date.
• closed_at: Optional[str] — order completion date.
• fuel_type: Optional[str] — fuel ID, e.g. "a95_premium".
• final_price: Optional[str] — the final price charged to the user, including discounts.
• liters_filled: Optional[str] — actual fuel volume. For example, "7.07".
• station_location: Optional[List[float]] — station location in the format [<longitude>, <latitude].

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

TankerOrdersResponse

class TankerOrdersResponse

Attributes:

• orders: List[TankerOrderItemResponse] — array of orders.
• last_closed_at: Optional[str] — the date the last order in the orders array was completed. The format is YYYY-MM-DDThh:mm:ss.sss in UTC without a time zone. If the array is empty, last_closed_at is not returned.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

BaseManager

class BaseManager

Attributes:

• yandex_login: str — manager's login.
• email: Optional[str] — manager's email.
• fullname: Optional[str] — manager's full name.
• phone: Optional[str] — manager's phone number.
• department_id: Optional[str] — department ID.

Methods:

• serialize — converts a class to JSON.

Manager

class Manager(BaseManager)

Attributes:

• role: Role — manager's role.

Methods:

• serialize — converts a class to JSON.

ManagerItemResponse

class ManagerItemResponse(BaseManager)

Attributes:

• id: str — manager ID.
• role: str — manager's email.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

ManagersListResponse

class ManagersListResponse

Attributes:

• items: List[ManagerItemResponse] — array of managers.
• limit: int — maximum number of returned records.
• total_amount: int — number of found records.
• cursor: Optional[str] — current request marker.
• next_cursor: Optional[str] — a marker for the next request. To get the next page, pass the value from the next_cursor field to the cursor GET parameter. If the answer is empty, the next_cursor field is missing.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

ManagerResponse

class ManagerResponse

Attributes:

• id: str — department manager ID.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

BaseLimit

class BaseLimit

Attributes:

• limit_id: str — limit ID.
• is_fleet_limit: Optional[bool] — whether there's a fleet limit or not.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

Limit

class Limit(BaseLimit)

Attributes:

• service: Service — ID of the service the limit is set for.

Methods:

• serialize — converts a class to JSON.

LimitResponse

class LimitResponse(BaseLimit)

Attributes:

• service: str — service ID for which the limit is set.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

BaseUser

class BaseUser

Attributes:

• fullname: str — employee's full name.
• phone: str — employee's phone number.
• is_active: bool — employee activity indicator. Inactive employees can't request rides or have rides requested by other users.
• email: Optional[str] — employee's email.
• cost_center: Optional[str] — the name of the client's cost center.
• cost_centers_id: Optional[str] — cost center settings ID. If the field isn't included in the request, the employee will be assigned the main cost center (if the client has new types of cost centers).
• nickname: Optional[str] — employee's nickname.
• department_id: Optional[str] — department ID.

Methods:

• serialize — converts a class to JSON.

User

class User(BaseUser)

Attributes:

• limits: Optional[List[Limit]] — information about limits.

Methods:

• serialize — converts a class to JSON.

UserGetResponse

class UserGetResponse(BaseUser)

Attributes:

• id: str — employee ID.
• is_deleted: bool — employee deletion flag (whether they're visible in the interface). Deleted employees can't be active.
• client_id: Optional[str] — client (account) ID.
• limits: Optional[List[LimitResponse]] — information about limits.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

UserCreateResponse

class UserCreateResponse

Attributes:

• id: str — employee ID.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

UserUpdateResponse

class UserUpdateResponse

Attributes:

• status: str — status.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

UserListResponse

class UserListResponse

Attributes:

• items: List[UserGetResponse] — array of client employees.
• limit: int — maximum number of returned records.
• total_amount: int — number of found records.
• cursor: Optional[str] — current request marker.
• next_cursor: Optional[str] — a marker for the next request. To get the next page, pass the value from the next_cursor field to the cursor GET parameter. If the answer is empty, the next_cursor field is missing.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

UsersSpendingListRequest

class UsersSpendingListRequest

Attributes:

• user_ids: List[str] — array of employee IDs (no more than 100).

Methods:

• serialize — converts a class to JSON.

LimitSpendingDetailsResponse

class LimitSpendingDetailsResponse

Attributes:

• orders_cost: Optional[str] — order cost limit.
• spent: Optional[str] — amount spent by the employee under this limit for the current period.
• orders_amount: Optional[int] — the maximum number of rides an employee can take during the period. Only for the taxi service.
• orders_spent: Optional[int] — number of completed orders in the current period.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

UserSpendingLimitItemResponse

class UserSpendingLimitItemResponse

Attributes:

• limit_id: str — limit ID.
• service: str — the name of the limit service.
• spending_details: LimitSpendingDetailsResponse — employee spending details.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

UserSpendingItemResponse

class UserSpendingItemResponse

Attributes:

• user_id: str — employee ID.
• limits: List[UserSpendingLimitItemResponse — information about the limits.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

UsersSpendingListResponse

class UsersSpendingListResponse

Attributes:

• users: List[UserSpendingItemResponse] — array of employees.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

BaseAccumulationRules

class BaseAccumulationRules

Attributes:

• started_at: Optional[str] — start time.

Methods:

• serialize — converts a class to JSON.

AccumulationRules

class AccumulationRules(BaseAccumulationRules)

Attributes:

• accumulation_period: AccumulationPeriod — accumulation period.

Methods:

• serialize — converts a class to JSON.

AccumulationRulesResponse

class AccumulationRulesResponse(BaseAccumulationRules)

Attributes:

• accumulation_period: str — accumulation period.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

GeoRestriction

class GeoRestriction

Attributes:

• source: Optional[str] — departure.
• destination: Optional[str] — destination.
• prohibiting_restriction: Optional[bool] — prohibition restriction.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

BaseTimeRestriction

class BaseTimeRestriction

Attributes:

• start_time: Optional[str] — start time of the restrictions.
• end_time: Optional[str] — end time of the restrictions.
• start_date: Optional[str] — start date of the restrictions.
• end_date: Optional[str] — end date of the restrictions.

Methods:

• serialize — converts a class to JSON.

TimeRestriction

class TimeRestriction(BaseTimeRestriction)

Attributes:

• type_time_restriction: TimeRestrictionType — time restriction type.
• days: Optional[List[Day]] — list of days of the week.

Methods:

• serialize — converts a class to JSON.

TimeRestrictionResponse

class TimeRestrictionResponse(BaseTimeRestriction)

Attributes:

• type_time_restriction: str — time restriction type.
• days: Optional[List[str]] — list of days of the week.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

CounterResponse

class CounterResponse

Attributes:

• users: int — number of users

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

BaseGeoHotelPolicy

class BaseGeoHotelPolicy

Attributes:

• geo_id: int — area ID.
• name: str — name.
• max_price_per_day: Optional[int] — maximum price per day.
• min_price_per_day: Optional[int] — minimum price per day.

Methods:

• serialize — converts a class to JSON.

GeoHotelPolicy

class GeoHotelPolicy(BaseGeoHotelPolicy)

Attributes:

• type_geo_hotel_policy: GeoHotelPolicyType — type.

Methods:

• serialize — converts a class to JSON.

GeoHotelPolicyResponse

class GeoHotelPolicyResponse(BaseGeoHotelPolicy)

Attributes:

• type_geo_hotel_policy: str — type.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

BaseHotelPolicy

class BaseHotelPolicy

Attributes:

• stars: Optional[List[int]] — array of star amount.
• max_price_per_day: Optional[int] — maximum price per day.
• min_price_per_day: Optional[int] — minimum price per day.

Methods:

• serialize — converts a class to JSON.

HotelPolicy

class HotelPolicy(BaseHotelPolicy)

Attributes:

• geo: Optional[GeoHotelPolicy] — hotel policy.
• weekly_restrictions: Optional[List[Day]] — restriction by day of the week.

Methods:

• serialize — converts a class to JSON.

HotelPolicyResponse

class HotelPolicyResponse(BaseHotelPolicy)

Attributes:

• geo: Optional[GeoHotelPolicyResponse] — hotel policy.
• weekly_restrictions: Optional[List[str]] — restriction by day of the week.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

BaseAviaPolicy

class BaseAviaPolicy

Attributes:

• max_price: Optional[int] — maximum price.
• min_price: Optional[int] — minimum price.
• extra_baggage: Optional[bool] — whether additional baggage is required.
• aeroexpress: Optional[bool] — whether an Aeroexpress train is required.

Methods:

• serialize — converts a class to JSON.

AviaPolicy

class AviaPolicy(BaseAviaPolicy)

Attributes:

• countries_restrictions: Optional[List[CountriesRestriction]] — country restrictions.
• classes: Optional[List[TravelClass]] — array of classes.

Methods:

• serialize — converts a class to JSON.

AviaPolicyResponse

class AviaPolicyResponse(BaseAviaPolicy)

Attributes:

• countries_restrictions: Optional[List[str]] — country restrictions.
• classes: Optional[List[str]] — array of classes.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

BudgetLimitRequest

class BudgetLimitRequest

Attributes:

• title: str — the name of the limit.
• service: Service — the service the limit applies to.
• client_id: Optional[str] — client (account) ID.
• department_id: Optional[str] — department ID.

Methods:

• serialize — converts a class to JSON.

BaseOrdersCostResponse

class BaseOrdersCostResponse

Attributes:

• value: float — value.
• period: str — period.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

TaxiOrdersCostLimitResponse

class TaxiOrdersCostLimitResponse(BaseOrdersCostResponse)

Attributes:

• accumulation_rules: Optional[AccumulationRulesResponse] — accumulation rules.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

OrdersAmountTaxiLimit

class OrdersAmountTaxiLimit

Attributes:

• value: float — value.
• period: MeasurePeriod — period.

Methods:

• serialize — converts a class to JSON.

OrdersCostTaxiLimit

class OrdersCostTaxiLimit

Attributes:

• value: float — value.
• period: MeasurePeriod — period.
• accumulation_rules: Optional[AccumulationRules] — accumulation rules.

Methods:

• serialize — converts a class to JSON.

TaxiLimits

class TaxiLimits

Attributes:

• orders_cost: Optional[OrdersCostTaxiLimit] — the maximum amount a client can spend in a period.
• orders_amount: Optional[OrdersAmountTaxiLimit] — the maximum number of rides a user can take in a given period.

Methods:

• serialize — converts a class to JSON.

TaxiLimitsResponse

class c

Attributes:

• orders_cost: Optional[TaxiOrdersCostLimitResponse] — the maximum amount a client can spend during a period.
• orders_amount: Optional[BaseOrdersCostResponse] — the maximum number of rides a user can request in a given period.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

EatOrdersCostLimitResponse

class EatOrdersCostLimitResponse(BaseOrdersCostResponse)

Attributes:

• accumulation_rules: Optional[AccumulationRulesResponse] — accumulation rules.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

OrdersCostEatsLimits

class OrdersCostEatsLimits

Attributes:

• value: float — value.
• period: MeasurePeriod — period.
• accumulation_rules: Optional[AccumulationRules] — accumulation rules.

Methods:

• serialize — converts a class to JSON.

EatsLimits

class EatsLimits

Attributes:

• orders_cost: OrdersCostEatsLimits — the maximum amount a user can spend in a given period.

Methods:

• serialize — converts a class to JSON.

EatLimitsResponse

class EatLimitsResponse

Attributes:

• orders_cost: Optional[EatOrdersCostLimitResponse] — the maximum amount a user can spend in a given period.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

OrdersCostDriveLimits

class OrdersCostDriveLimits

Attributes:

• value: float — value.
• period: MeasurePeriod — period.

Methods:

• serialize — converts a class to JSON.

DriveLimits

class DriveLimits

Attributes:

• orders_cost: OrdersCostDriveLimits — the maximum amount a client can spend in a given period.

Methods:

• serialize — converts a class to JSON.

DriveLimitsResponse

class DriveLimitsResponse

Attributes:

• orders_cost: BaseOrdersCostResponse — the maximum amount a client can spend in a given period.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

TankerOrdersCostLimit

class TankerOrdersCostLimit(BaseOrdersCostResponse)

Attributes:

• kind: Optional[str] — measurement type.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

TankerLimits

class TankerLimits

Attributes:

• value: float — value.
• period: MeasurePeriod — period.
• kind: Optional[MeasureKind] — measurement type.

Methods:

• serialize — converts a class to JSON.

TankerLimitsResponse

class TankerLimitsResponse

Attributes:

• orders_cost: Optional[TankerOrdersCostLimit] — the maximum amount a client can spend in a period.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

OrdersCostAmountCargoLimit

class OrdersCostAmountCargoLimit

Attributes:

• value: float — value.
• period: MeasurePeriod — period.

Methods:

• serialize — converts a class to JSON.

CargoLimits

class CargoLimits

Attributes:

• orders_cost: Optional[OrdersCostAmountCargoLimit] — the maximum amount a client can spend in a period.
• orders_amount: Optional[OrdersCostAmountCargoLimit] — the maximum number of rides a client can take in a given period.

Methods:

• serialize — converts a class to JSON.

CargoLimitsResponse

class CargoLimitsResponse

Attributes:

• orders_cost: Optional[BaseOrdersCostResponse] — the maximum amount a client can spend in a given period.
• orders_amount: Optional[BaseOrdersCostResponse] — the maximum number of rides a user can request in a given period.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

OrdersCostTravelLimits

class OrdersCostTravelLimits

Attributes:

• value: float — value.
• period: OrdersCostTravelLimitPeriod — period.

Methods:

• serialize — converts a class to JSON.

TravelLimits

class TravelLimits

Attributes:

• orders_cost: Optional[OrdersCostTravelLimits] — the maximum amount a client can spend in a period.

Methods:

• serialize — converts a class to JSON.

TravelLimitsResponse

class TravelLimitsResponse

Attributes:

• orders_cost: Optional[BaseOrdersCostResponse] — the maximum amount a client can spend in a given period.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

BudgetLimitTaxiRequest

class BudgetLimitTaxiRequest(BudgetLimitRequest)

Attributes:

• categories: List[str] — list of available service classes.
• limits: TaxiLimits — limits.
• enable_toll_rojson: Optional[bool] — availability of toll roads.
• geo_restrictions: Optional[List[GeoRestriction]] — information about the allowed ride areas.
• time_restrictions: Optional[List[TimeRestriction]] — time restrictions.

Methods:

• serialize — converts a class to JSON.

BudgetLimitEatsRequest

class BudgetLimitEatsRequest(BudgetLimitRequest)

Attributes:

• limits: EatsLimits — limits.
• is_qr_enabled: Optional[bool] — whether QR code payments are enabled at vending machines.
• geo_restrictions: Optional[List[GeoRestriction]] — information about the allowed ride areas.
• time_restrictions: Optional[List[TimeRestriction]] — time restrictions.

Methods:

• serialize — converts a class to JSON.

BudgetLimitTankerRequest

class BudgetLimitTankerRequest(BudgetLimitRequest)

Attributes:

• limits: TankerLimits — limits.
• fuel_types: Optional[List[str]] — list of available fuel types.
• geo_restrictions: Optional[List[GeoRestriction]] — information about the allowed ride areas.
• time_restrictions: Optional[List[TimeRestriction]] — time restrictions.

Methods:

• serialize — converts a class to JSON.

BudgetLimitDriveRequest

class BudgetLimitDriveRequest(BudgetLimitRequest)

Attributes:

• limits: DriveLimits — limits.
• time_restrictions: Optional[List[TimeRestriction]] — time restrictions.
• cities: Optional[List[str]] — cities.
• tariffs: Optional[List[str]] — list of available service classes.
• cars_classes: Optional[List[str]] — list of available car classes.
• insurance_types: Optional[List[str]] — types of insurance.
• enable_toll_rojson: Optional[bool] — availability of toll roads.

Methods:

• serialize — converts a class to JSON.

BudgetLimitGroceryRequest

class BudgetLimitGroceryRequest(BudgetLimitRequest)

Attributes:

• limits: EatsLimits — limits.
• geo_restrictions: Optional[List[GeoRestriction]] — information about the allowed ride areas.
• time_restrictions: Optional[List[TimeRestriction]] — time restrictions.

Methods:

• serialize — converts a class to JSON.

BudgetLimitCargoRequest

class BudgetLimitCargoRequest(BudgetLimitRequest)

Attributes:

• limits: CargoLimits — limits.
• categories: List[str] — list of available service classes.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

BudgetLimitTravelRequest

class BudgetLimitTravelRequest(BudgetLimitRequest)

Attributes:

• limits: TravelLimits — limits.
• hotel_policy: Optional[HotelPolicy] — hotel policy.
• avia_policy: Optional[AviaPolicy] — air travel policy.
• allow_reservations_without_approve: Optional[bool] — option to reserve without approval.
• approve_role: Optional[ApproveRole] — approving role.
• approve_roles: Optional[List[ApproveRole]] — approving roles.

Methods:

• serialize — converts a class to JSON.

BaseLimitResponse

class BaseLimitResponse

Attributes:

• id: str — limit ID.
• title: str — the name of the limit.
• service: str — service ID for which the limit is set.
• client_id: str — client ID.
• counters: CounterResponse — number of employees with this limit.
• is_default: bool — indicator of whether this default limit is used (set when the service is activated for the client).
• can_edit: Optional[bool] — indicator of whether the user can edit or delete this limit.
• department_id: Optional[str] — department ID the limit is associated with. If the department is missing, it's the root department.

Methods:

• serialize — converts a class to JSON.

TaxiLimitResponse

class TaxiLimitResponse(BaseLimitResponse)

Attributes:

• limits: TaxiLimitsResponse — limits.
• categories: List[str] — list of available service classes.
• geo_restrictions: Optional[List[GeoRestriction]] — information about the allowed ride areas.
• time_restrictions: Optional[List[TimeRestriction]] — time restrictions.
• enable_toll_rojson: Optional[bool] — availability of toll roads.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

EatLimitResponse

class EatLimitResponse(BaseLimitResponse)

Attributes:

• limits: EatLimitsResponse — limits.
• geo_restrictions: Optional[List[GeoRestriction]] — information about the allowed ride areas.
• time_restrictions: Optional[List[TimeRestriction]] — time restrictions.
• is_qr_enabled: Optional[bool] — whether QR code payments are enabled at vending machines.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

GroceryLimitResponse

class GroceryLimitResponse(BaseLimitResponse)

Attributes:

• limits: EatLimitsResponse — limits.
• geo_restrictions: Optional[List[GeoRestriction]] — information about the allowed ride areas.
• time_restrictions: Optional[List[TimeRestriction]] — time restrictions.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

DriveLimitResponse

class DriveLimitResponse(BaseLimitResponse)

Attributes:

• limits: DriveLimitsResponse — limits.
• cities: Optional[List[str]] — list of available cities.
• tariffs: Optional[List[str]] — list of available service classes.
• cars_classes: Optional[List[str]] — list of available car classes.
• insurance_types: Optional[List[str]] — information about the allowed ride areas.
• time_restrictions: Optional[List[TimeRestriction]] — time restrictions.
• enable_toll_rojson: Optional[bool] — availability of toll roads.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

TankerLimitResponse

class TankerLimitResponse(BaseLimitResponse)

Attributes:

• limits: TankerLimitsResponse — limits.
• geo_restrictions: Optional[List[GeoRestriction]] — information about the allowed ride areas.
• time_restrictions: Optional[List[TimeRestriction]] — time restrictions.
• fuel_types: List[str] — list of available fuel types.
• is_fleet_limit: Optional[bool] — whether there's a fleet limit or not.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

CargoLimitResponse

class CargoLimitResponse(BaseLimitResponse)

Attributes:

• limits: CargoLimitsResponse — limits.
• categories: List[str] — list of available service classes.
• is_fleet_limit: Optional[bool] — whether there's a fleet limit or not.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

TravelLimitResponse

class TravelLimitResponse(BaseLimitResponse)

Attributes:

• limits: TravelLimitsResponse — limits.
• allow_reservations_without_approve: bool — option to reserve without approval.
• approve_role: str — approving role.
• approve_roles: List[str] — approving roles.
• travel_policy_id: Optional[str] — travel policy ID.
• hotel_policy: Optional[HotelPolicyResponse] — hotel policy.
• avia_policy: Optional[AviaPolicyResponse] — air travel policy.
• is_fleet_limit: Optional[bool] — whether there's a fleet limit or not.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

BudgetLimitListResponse

class BudgetLimitListResponse

Attributes:

• items: List[Union[TaxiLimitResponse, EatLimitResponse, GroceryLimitResponse, DriveLimitResponse, TankerLimitResponse, CargoLimitResponse, TravelLimitResponse]] — list of limits.
• limit: int — maximum number of returned records.
• offset: int — number of skipped records.
• total_amount: int — number of found records.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

BudgetLimitUpdateResponse

class BudgetLimitUpdateResponse

Attributes:

• id: str — updated limit ID.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

FieldSettingResponse

class FieldSettingResponse

Attributes:

• title: str — field name.
• required: bool — whether the field is required when ordering.
• services: List[str] — IDs of service where this field can be used when ordering.
• format: str — updated limit ID.
• values: List[str] — list of cost centers available to the employee.
• id: Optional[str] — field ID.
• hidden: Optional[bool] — don't show or use this field when ordering.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

BudgetCostCenterItemResponse

class BudgetCostCenterItemResponse

Attributes:

• id: Optional[str] — cost center ID.
• name: Optional[str] — cost center name.
• default: Optional[bool] — indicator of whether this cost center is used by default (set when the service is activated for the client).
• field_settings: Optional[List[FieldSettingResponse]] — list of settings for each cost center field.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

BudgetCostCenterListResponse

class BudgetCostCenterListResponse

Attributes:

• items: List[BudgetCostCenterItemResponse] — list of cost centers.
• limit: int — maximum number of returned records.
• offset: int — number of skipped records.
• total_amount: int — number of found records.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

Department

class Department

Attributes:

• name: str — name of the new department.
• parent_id: Optional[str] — ID of the parent department we want to attach the new department to. If parent_id is null, then the department is attached to the root department.

Methods:

• serialize — converts a class to JSON.

DepartmentCreateResponse

class DepartmentCreateResponse

Attributes:

• id: str — department ID.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

DepartmentBudget

class DepartmentBudget

Attributes:

• budget: Optional[Union[float, int, Decimal]] — department budget.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

DepartmentBudgetResponse

class DepartmentBudgetResponse(DepartmentBudget)

Methods:

• new — returns an instance of the class.

DepartmentLimitsResponse

class DepartmentLimitsResponse

Attributes:

• taxi: DepartmentBudgetResponse — the department's budget for Taxi.
• eats: DepartmentBudgetResponse — the department's budget for Eats.
• tanker: DepartmentBudgetResponse — the department's budget for Refuel.
• cargo: DepartmentBudgetResponse — the department's budget for Delivery.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

DepartmentItemResponse

class DepartmentItemResponse(Department)

Attributes:

• id: str — department ID.
• limits: DepartmentLimitsResponse — service limits on the total amount department users can spend.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

DepartmentListResponse

class DepartmentListResponse

Attributes:

• items: List[DepartmentItemResponse) — list of departments.
• limit: int — maximum number of returned records.
• offset: int — number of skipped records.
• total_amount: int — number of found records.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

DepartmentUpdateRequest

class DepartmentUpdateRequest

Attributes:

• name: Optional[str] — department name.
• parent_id: Optional[str] — parent department ID.

Methods:

• serialize — converts a class to JSON.

DepartmentUpdateResponse

class DepartmentUpdateResponse

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

DepartmentDeleteResponse

class DepartmentDeleteResponse

Attributes:

• deleted_ids: List[str] — ID list of all deleted departments.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

RoutePointExtraData

class RoutePointExtraData

Attributes:

• floor: Optional[str] — floor.
• apartment: Optional[str] — apartment.
• comment: Optional[str] — comment.
• contact_phone: Optional[str] — phone number.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

BaseRoutePoint

class BaseRoutePoint

Attributes:

• fullname: Optional[str] — full name.
• geopoint: Optional[List[Union[int, float, Decimal]]] — coordinates.
• porchnumber: Optional[str] — entrance number.
• extra_data: Optional[RoutePointExtraData) — additional information.

Methods:

• serialize — converts a class to JSON.

RoutePoint

class RoutePoint(BaseRoutePoint)

Attributes:

• country: Optional[str] — country.
• locality: Optional[str] — city/town.
• premisenumber: Optional[str] — building number.
• thoroughfare: Optional[str] — street or neighborhood name (for addresses with numbering within neighborhood).

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

RoutePointResponse

class RoutePointResponse(BaseRoutePoint)

Attributes:

• passed: Optional[bool] — whether the route point was passed or not.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

Order

class Order

Attributes:

• user_id: str — employee ID.
• route: List[RoutePoint] — list of route point coordinates.
• class_tariff: str — service class of the ride.
• due_date: Optional[str] — the time by which the order must be created. Value format: YYYY-MM-DDThh:mm:ss±hh:mm.
• offer: Optional[str] — ID of the offer obtained in the request to get route statistics and information about service classes.
• requirements: Optional[Dict[str, Union[bool, int, str]]] — additional order requirements.
• cost_center_values: Optional[List[CostCenter]] — new cost center fields.
• comment: Optional[str] — driver instructions.

Methods:

• serialize — converts a class to JSON.

TaxiOrderTollRoadsResponse

class TaxiOrderTollRoadsResponse

Attributes:

• user_chose_toll_road: Optional[bool] — the user chose a toll road.
• user_had_choice: Optional[bool] — the user had a choice (there was a free alternative).
• auto_payment: Optional[bool] — payment for toll roads from the corporate account.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

TaxiOrderItemResponse

class TaxiOrderItemResponse

Attributes:

• id: Optional[str] — order ID.
• user_id: Optional[str] — user ID.
• status: Optional[str] — order status.
• class_tariff: Optional[str] — service class name.
• source: Optional[RoutePointResponse] — route start point.
• interim_destinations: Optional[List[RoutePointResponse]] — stops along the way.
• destination: Optional[RoutePointResponse] — destination point.
• cost_center_values: Optional[List[CostCenter]] — new cost center fields.
• due_date: Optional[str] — ride start date and time. Value format: YYYY-MM-DDThh:mm:ss±hh:mm.
• finished_date: Optional[str] — ride end date and time. Returned only for completed orders. Value format: YYYY-MM-DDThh:mm:ss±hh:mm.
• cost: Optional[Union[int, float, Decimal]] — ride and toll road cost (if applicable) excluding VAT. Returned only for completed orders.
• cost_with_vat: Optional[Union[int, float, Decimal]] — ride and toll road cost (if applicable) with VAT. Returned only for completed orders.
• toll_roads: Optional[TaxiOrderTollRoadsResponse] — toll roads.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

TaxiOrderListResponse

class TaxiOrderListResponse

Attributes:

• items: List[TaxiOrderItemResponse] — list of client orders.
• limit: int — maximum number of returned records.
• offset: int — number of skipped records.
• total_amount: int — number of found records.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

TaxiOrderCancelRulesResponse

class TaxiOrderCancelRulesResponse

Attributes:

• can_cancel: Optional[bool] — whether the order can be canceled.
• message: Optional[str] — text description of the cancellation rules.
• state: Optional[str] — current status of the option to cancel the order.
• title: Optional[str] — cancellation policy name.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

TaxiOrderPerformerVehicleResponse

class TaxiOrderPerformerVehicleResponse

Attributes:

• model: Optional[str] — car model.
• number: Optional[str] — vehicle license plate number.
• color: Optional[str] — vehicle color.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

TaxiOrderPerformerResponse

class TaxiOrderPerformerResponse

Attributes:

• vehicle: Optional[TaxiOrderPerformerVehicleResponse] — information about the vehicle.
• fullname: Optional[str] — driver's full name.
• phone: Optional[str] — driver's phone number.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

TaxiOrderGetResponse

class TaxiOrderGetResponse(TaxiOrderItemResponse)

Attributes:

• performer: Optional[TaxiOrderPerformerResponse] — information about the vehicle and driver.
• cancel_rules: Optional[TaxiOrderCancelRulesResponse) — order cancellation rules.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

TaxiOrderCancelResponse

class TaxiOrderCancelResponse

Attributes:

• status: str — order status.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

OrderCreateResponse

class OrderCreateResponse

Attributes:

• order_id: str — order ID.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

TaxiActiveOrderItemResponse

class TaxiActiveOrderItemResponse

Attributes:

• id: str — order ID.
• status: str — order status.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

TaxiActiveOrderListResponse

class TaxiActiveOrderListResponse

Attributes:

• items: List[TaxiActiveOrderItemResponse] — array with route data.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

OrderRequest

class OrderRequest

Attributes:

• route: List[List[Union[int, float, Decimal]]] — list of route point coordinates.
• due_date: Optional[str] — the time by which the order must be created. Value format: YYYY-MM-DDThh:mm:ss±hh:mm.
• requirements: Optional[Dict[str, Union[bool, int, str]]] — additional order requirements.
• user_id: Optional[str] — employee ID.
• use_toll_roads: Optional[bool] — toll road use.

Methods:

• serialize — converts a class to JSON.

TaxiOrderEstimatedWaitingResponse

class TaxiOrderEstimatedWaitingResponse

Attributes:

• seconds: int — wait time in seconds.
• message: str — time in text format.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

TaxiOrderDetailsTariffItemResponse

class TaxiOrderDetailsTariffItemResponse

Attributes:

• type_tariff: str — type of the component.
• value: str — description of the component.
• type_details: Optional[str] — details about the component type (for example, the option name).

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

TaxiOrderServiceLevelResponse

class TaxiOrderServiceLevelResponse

Attributes:

• class_tariff: Optional[str] — service class.
• is_fixed_price: Optional[bool] — fixed price indicator.
• price: Optional[str] — estimated ride price.
• estimated_waiting: Optional[TaxiOrderEstimatedWaitingResponse] — estimated wait time.
• details_tariff: Optional[List[TaxiOrderDetailsTariffItemResponse]] — description of the minimum service class components.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

TollRoadsResponse

class TollRoadsResponse

Attributes:

• has_tolls: bool — whether there are toll roads.
• auto_payment: bool — payment for toll roads from the corporate account.
• price: Optional[str] — toll road price.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

TaxiOrderRoutestatsGetResponse

class TaxiOrderRoutestatsGetResponse

Attributes:

• offer: Optional[str] — offer ID.
• service_levels: Optional[List[TaxiOrderServiceLevelResponse]] — list of service classes with descriptions.
• toll_roads: Optional[TollRoadsResponse] — toll road sections.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

Feedback

class Feedback

Attributes:

• rating: int — order completion rating. An integer from 1 to 5.
• msg: Optional[str] — comment for the completed order.

Methods:

• serialize — converts a class to JSON.

TaxiFeedbackCreateResponse

class TaxiFeedbackCreateResponse

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

TaxiOrderDestinationsUpdateRequest

class TaxiOrderDestinationsUpdateRequest

Attributes:

• created_time: str — UTC time when the change was created. Value format: YYYY-MM-DDThh:mm:ss±hh:mm.
• destinations: List[RoutePoint] — route points of the modified route, except the starting point.

Methods:

• serialize — converts a class to JSON.

TaxiOrderDestinationsUpdateResponse

class TaxiOrderDestinationsUpdateResponse

Attributes:

• changed_destinations: Optional[List[RoutePoint]] — changed route.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

VehicleInfoResponse

class VehicleInfoResponse

Attributes:

• location: List[Union[int, float, Decimal]] — vehicle coordinates.

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

TaxiOrderStatusGetResponse

class TaxiOrderStatusGetResponse

Attributes:

• status: str — order status.
• vehicle: Optional[VehicleInfoResponse] — information about the vehicle's location.
• time_left_raw: Optional[Union[int, float, Decimal]] — time until the driver arrives or the order is completed (in seconds).

Methods:

• serialize — converts a class to JSON.
• new — returns an instance of the class.

OrdersCancelRequest

class OrdersCancelRequest

Attributes:

• state: TaxiOrderCancelRulesState — the current status of the option to cancel. Possible values: free, paid, minimal. You can get the status from the Order information request.

Methods:

• serialize — converts a class to JSON.